<HTML>
<HEAD>
<TITLE>HELP - HowToDocument</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - HowToDocument</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">HowToDocument</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("divID601","aID601","LeftMenuActive","leftMenuLinkActive");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_public',this)" class="tabLinkInActive">Public</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Protected</span></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_private',this)" class="tabLinkInActive">Private</a></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_related',this)" class="tabLinkActive">Related</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_all',this)" class="tabLinkInActive">All</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Inheritance</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Collaboration</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="paragraphTable"></div>
<table cellspacing="0"cellpadding=0 border=0 class="widthAndBorderTop">
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Friends</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>Brief description</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','operatoreq_eq_2320704071',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>friend bool&nbsp;&nbsp;operator==&nbsp;&nbsp;(const HowToDocument & lhs, const HowToDocument & rhs)',CAPTION,'<strong>Brief description</strong><BR>Friend functions goes on the related tab in the HTML output.');" onmouseout="return nd();">&nbsp;operator==</a></TD>
<TD class="paddingNormal2"><span class="" >Friend functions goes on the related tab in the HTML output.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Functions</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>&nbsp;</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','RelatedFunction122',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;RelatedFunction&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Related function when declared in class\' header-file.');" onmouseout="return nd();">&nbsp;RelatedFunction</a></TD>
<TD class="paddingNormal2"><span class="" >Related function when declared in class' header-file.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Macros</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>&nbsp;</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','MACRO_PARAMETERS238736690',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>define&nbsp;&nbsp;MACRO_PARAMETERS&nbsp;&nbsp;(x , y )',CAPTION,'<strong>Brief description</strong><BR>Documenting parameters for macro.');" onmouseout="return nd();">&nbsp;MACRO_PARAMETERS</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> parameters for macro.<br>
</TD>
</TR>
</table>
<div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_class','_related');
</script>
